Subjects UltraDock DLL Version 0.12

Introduction

General Commands
ShowSwitchbar
ShowToolbar
ShowMenubar
IsSwitchbar
IsToolbar
IsMenubar
SBSize
TBSize
SBPos
Version

Docking Commands
Dock
UnDock
DockPos
DockSide

DLL Signals
SIZEEND

Futur Expansions
 

>> Introduction



This DLL lets you dock dialogs around the mIRC window.

Every function in this DLL returns a value if used with the $dll identifier. U_OK if successful, U_ERROR otherwise.

N.B. This DLL is meant to replace my old docking DLL called RebaR.dll.

>> General Commands



These general commands affect how mIRC will look like. You can disable the mIRC toolbar and/or switchbar with some commands. Some other commands let you dock a dialog on each of the four sides of the mIRC window.

ShowSwitchbar



This command lets you hide/show the mIRC Switchbar. (1: show - 0: hide)

Command:

/dll UltraDock.dll ShowSwitchbar [1|0]
$dll(UltraDock.dll,ShowSwitchbar,[1|0])

Succes Return Value:

U_OK

ShowToolbar



This command lets you hide/show the mIRC Toolbar. (1: show - 0: hide)

Command:

/dll UltraDock.dll ShowToolbar [1|0]
$dll(UltraDock.dll,ShowToolbar,[1|0])

Succes Return Value:

U_OK

ShowMenubar



This command lets you hide/show the mIRC Menubar. (1: show - 0: hide)

Command:

/dll UltraDock.dll ShowMenubar [1|0]
$dll(UltraDock.dll,ShowMenubar,[1|0])

Succes Return Value:

U_OK

IsSwitchbar



This command returns wether the switchbar is visible or not.

Command:

$dll(UltraDock.dll,IsSwitchbar,.)

Succes Return Value:

$true or $false

IsToolbar



This command returns wether the toolbar is visible or not.

Command:

$dll(UltraDock.dll,IsToolbar,.)

Succes Return Value:

$true or $false

IsMenubar



This command returns wether the menubar is visible or not.

Command:

$dll(UltraDock.dll,IsMenubar,.)

Succes Return Value:

$true or $false

SBSize



This command returns mIRC's Switchbar width and height.

Command:

$dll(UltraDock.dll,SBSize,.)

Succes Return Value:

W H

TBSize



This command returns mIRC's Toolbar width and height.

Command:

$dll(UltraDock.dll,TBSize,.)

Succes Return Value:

W H

SBPos



This command returns the mIRC Switchbar position.

Command:

$dll(UltraDock.dll,SBPos,.)

Succes Return Value:

  • 0 - no switchbar
  • 1 - left
  • 2 - right
  • 3 - top
  • 4 - bottom

Version



This command returns information on the DLL version.

Command:

$dll(UltraDock.dll,Version,.)

Succes Return Value:

DLL Version and author information

>> Docking Commands



Dock



This command lets you dock a dialog on mIRC's Client window. You can dock any number of dialogs you want. The dialog docking around the window follows a docking order list which means the first docked dialog gets the fullsize dimensions of the window, the second the remaining dismensions and so on until the last one is reached.

Command:

$dll(UltraDock.dll,Dock, N [HWND] [POSITION] [NAME])
/dll UltraDock.dll Dock N [HWND] [POSITION] [NAME]

Succes Return Value:

U_OK

Values:

  • N - N is the index in which the dialog will be inserted in the docking order. Index 0 is the first dialog. If the index value is -1 then the dialog is added at the end of the docking order.
  • HWND - Handle to the dialog window as given by the mIRC identifier $dialog(name).hwnd
  • POSITION - Docking position of the dialog (top, bottom, left, right)
  • NAME - Dialog name.

UnDock



This command lets you release from it's docking position a dialog and restore it to it's original floating state.

Command:

$dll(UltraDock.dll,UnDock, N)
/dll UltraDock.dll UnDock N

Succes Return Value:

U_OK

Values:

  • N - Docked index of the dialog in the current order list
N.B. Remember the first POSITION has index 0 and when you undock an item, the remaining indexes are from [0->N-1] N.B. You must undock the dialog before closing it or else the docking order list will be "fucked up".

DockPos



This command lets you retrieve the docking index of a dialog based on it's name.

Command:

$dll(UltraDock.dll,DockPos,[NAME])


Succes Return Value:

N or -1 if fails

Values:

  • NAME - Dialog name.

DockSide



This command lets you retrieve the docking position of a dialog baed on it's name.

Command:

$dll(UltraDock.dll,DockSide,[NAME])

Succes Return Value:

[left|right|top|bottom] or -1 if fails

Values:

  • NAME - Dialog name.

>> DLL Signals



The DLL sends some signals on certain events. You can capture the signal event using ON *:SIGNAL:UltraDock:*: { }. The parameter $1 will contain the signal description of the given signals below.

SIZEEND



This signal is sent when mIRC's resizing is finished.

>> Future Expansions



Comments, Suggestions and Ideas on commands I could integrate in the DLL are welcome.

UltraDock DLL



- ClickHeRe
- © 2004
- Testing -> McFly, Huzard, elizio
- Compiled with -> Visual Studio .NET 2003
- #scriptsdb.org @ Undernet @ Webnet
- http://scriptsdb.org


Tha... Help SDB mIRC Group Contact